Skip to content

Fix: Set dtype to 'float32' in sf.read to prevent PyTorch type mismatch#1

Open
Miyoko076 wants to merge 1 commit intojhj0517:mainfrom
Miyoko076:main
Open

Fix: Set dtype to 'float32' in sf.read to prevent PyTorch type mismatch#1
Miyoko076 wants to merge 1 commit intojhj0517:mainfrom
Miyoko076:main

Conversation

@Miyoko076
Copy link
Copy Markdown

Description

This PR explicitly sets dtype='float32' when falling back to soundfile.read() in utils/fastio.py.

Why is this needed?

By default, soundfile.read() returns a float64 (Double) array. When ultimatevocalremover_api is used as a dependency in PyTorch-based pipelines (like Whisper-WebUI), this default behavior causes a crash (RuntimeError: expected scalar type Double but found Float) during downstream operations such as audio resampling.

Explicitly requesting float32 from soundfile fixes this crash and avoids unnecessary memory overhead from allocating a Double array.

Related Issue

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical compatibility issue arising from the default data type returned by soundfile.read() when integrated into PyTorch-based applications. By enforcing float32 as the data type for audio signals, it eliminates runtime errors caused by type mismatches and optimizes memory usage, thereby enhancing the robustness and efficiency of downstream audio processing workflows.

Highlights

  • Type Mismatch Fix: Explicitly set the dtype parameter to 'float32' when calling soundfile.read() in utils/fastio.py.
  • PyTorch Compatibility: Resolved a RuntimeError (expected scalar type Double but found Float) that occurred in PyTorch-based pipelines when soundfile.read() returned a default float64 array, ensuring seamless integration.
  • Memory Optimization: Prevented unnecessary memory overhead by avoiding the allocation of float64 arrays, opting for the more memory-efficient float32.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • src/utils/fastio.py
    • Modified the sf.read() fallback to explicitly request dtype='float32' for audio signals.
Activity
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses a RuntimeError in PyTorch-based pipelines by ensuring that soundfile.read returns audio data with float32 dtype, which is consistent with other audio reading libraries used in the function. The change is correct and well-justified. My main feedback is to add a unit test to verify this fix and prevent future regressions, as the corresponding test file is currently empty.

if signal is None:
try:
signal, sampling_rate = sf.read(path)
signal, sampling_rate = sf.read(path, dtype='float32')
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This change correctly addresses the data type mismatch. To ensure this fix is robust and to prevent future regressions, it would be beneficial to add a unit test. The test file tests/utils/test_fastio.py is currently empty. A test case could be added there to specifically verify that when soundfile.read is used as a fallback, the resulting audio data has the float32 dtype.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RuntimeError: expected scalar type Double but found Float during BGM Separation (caused by ultimatevocalremover_api)

1 participant